API Documentation
Classes | Public Member Functions | List of all members
nkWinUi::ComboBox Class Reference

A graphical combo box. More...

Inheritance diagram for nkWinUi::ComboBox:
nkWinUi::Component nkExport::Exportable

Classes

class  Entry
 Represents an entry within the combo box. More...
 

Public Member Functions

 ComboBox ()
 
 ~ComboBox ()
 
EntrygetEntryPerLabel (const std::string_view &label) const
 
EntrygetEntryPerData (void *data) const
 
virtual EntrygetCurrentSelection () const
 
comboSelectionCallback getSelectionSpecializedCallback () const
 
void setSelectionSpecializedCallback (comboSelectionCallback value)
 
void setSelectedEntryPerLabel (const std::string_view &label)
 
void setSelectedEntryPerData (void *data)
 
virtual void setSelectedEntry (Entry *selected)
 
virtual EntryinsertEntry (const std::string_view &label, void *data)
 
void setEntryData (const std::string_view &label, void *newData)
 
virtual void * deleteEntry (const std::string_view &label)
 
virtual void clearEntries ()
 
virtual void exportIntrospection (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkWinUi::Component
 Component ()
 
virtual ~Component ()
 
LayoutgetLayout () const
 
nkMaths::Point getPositionInParent () const
 
nkMaths::Point getPositionInScreen () const
 
int getWidth () const
 
int getHeight () const
 
nkMaths::Rectangle getArea () const
 
virtual nkMaths::Point getBorderExtents () const
 
virtual int getLayoutAllowedWidth () const
 
virtual int getLayoutAllowedHeight () const
 
virtual int getLayoutAllowedOffsetX () const
 
virtual int getLayoutAllowedOffsetY () const
 
bool isInitialized () const
 
ComponentgetParentComponent () const
 
COMPONENT_TYPE getComponentType () const
 
const char * getComponentName () const
 
bool getVisibility () const
 
virtual const char * getLabel () const
 
void * getData () const
 
bool isEnabled () const
 
bool isForegroundWindow () const
 
unsigned int getZDepth () const
 
bool getVisibleOnLoad () const
 
virtual LayoutsetLayout (LAYOUT_TYPE layoutType)
 
virtual void setPositionInParent (nkMaths::Point position)
 
virtual void setPositionInScreen (nkMaths::Point position)
 
virtual void setSize (int width, int height)
 
virtual void setWidth (int width)
 
virtual void setHeight (int height)
 
void setMinSize (unsigned int width, unsigned int height)
 
void setMaxSize (unsigned int width, unsigned int height)
 
void setRatio (float widthOverHeight)
 
virtual void setArea (nkMaths::Rectangle area)
 
virtual void setParentComponent (Component *parent, bool makeItVisible=true)
 
virtual void setLabel (const std::string_view &label)
 
void setComponentName (const std::string_view &name)
 
virtual void setVisibility (bool value)
 
void setData (void *data)
 
void setEnabled (bool value)
 
void setVisibleOnLoad (bool value)
 
void addChild (Component *child, bool makeItVisible=true)
 
void removeChild (Component *child)
 
void removeChild (unsigned int index)
 
ComponentgetChild (unsigned int index)
 
unsigned int getChildIndex (Component *child)
 
void unloadWithChildren ()
 
void loadWithChildren ()
 
void updateZDepth ()
 
void bringToForeground ()
 
void focusWindow ()
 
nkMaths::Point getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords)
 
nkMaths::Point getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords)
 
virtual void load ()=0
 
virtual void unload ()=0
 
virtual void updateWindow ()
 
void onSized ()
 
ContextMenucreateContextMenu ()
 
ContextMenugetCurrentContextMenu ()
 
void shutContextMenu ()
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A graphical combo box.

Constructor & Destructor Documentation

◆ ComboBox()

nkWinUi::ComboBox::ComboBox ( )

Constructor.

◆ ~ComboBox()

nkWinUi::ComboBox::~ComboBox ( )

Destructor.

Member Function Documentation

◆ getEntryPerLabel()

Entry* nkWinUi::ComboBox::getEntryPerLabel ( const std::string_view &  label) const
Parameters
labelThe label of the entry that needs to be obtained.
Returns
The entry featuring the label requested if available, nullptr else.

◆ getEntryPerData()

Entry* nkWinUi::ComboBox::getEntryPerData ( void *  data) const

Returns the entry in the combo box that has the data provided attached.

Parameters
dataThe data pointer the entry requested should have.
Returns
The entry featuring the user data requested if available, nullptr else.

◆ getCurrentSelection()

virtual Entry* nkWinUi::ComboBox::getCurrentSelection ( ) const
virtual
Returns
The currently selected entry, if any. Else, nullptr.

◆ getSelectionSpecializedCallback()

comboSelectionCallback nkWinUi::ComboBox::getSelectionSpecializedCallback ( ) const
Returns
The selection callback sets on the component.

◆ setSelectionSpecializedCallback()

void nkWinUi::ComboBox::setSelectionSpecializedCallback ( comboSelectionCallback  value)

Sets the selection callback. Will be called over the global selection callback set in the InputSystem.

Parameters
valueThe callback to use.

◆ setSelectedEntryPerLabel()

void nkWinUi::ComboBox::setSelectedEntryPerLabel ( const std::string_view &  label)

Sets the selected entry, using the label.

Parameters
labelThe label to find the entry to select.

◆ setSelectedEntryPerData()

void nkWinUi::ComboBox::setSelectedEntryPerData ( void *  data)

Sets the selected entry, using the data that should be attached to it.

Parameters
dataThe data to find the entry to select.

◆ setSelectedEntry()

virtual void nkWinUi::ComboBox::setSelectedEntry ( Entry selected)
virtual

Sets the selected entry.

Parameters
selectedThe entry to select.

◆ insertEntry()

virtual Entry* nkWinUi::ComboBox::insertEntry ( const std::string_view &  label,
void *  data 
)
virtual

Inserts a new entry within the combo box.

Parameters
labelThe label the entry should have.
dataThe user data to attach to the entry.
Returns
The entry freshly created.
Remarks
The component is the owner of the entry returned. The entry is not responsible for the user data memory.

◆ setEntryData()

void nkWinUi::ComboBox::setEntryData ( const std::string_view &  label,
void *  newData 
)

Overrides the user data attached to an entry.

Parameters
labelThe label to find back the entry requested.
newDataThe user data to attach to the entry.

◆ deleteEntry()

virtual void* nkWinUi::ComboBox::deleteEntry ( const std::string_view &  label)
virtual

Erases an entry. Entry memory will be freed.

Parameters
labelthe label to find back the entry requested.

◆ clearEntries()

virtual void nkWinUi::ComboBox::clearEntries ( )
virtual

Clear all entries from the combo box. Entries memory will be freed.

◆ exportIntrospection()

virtual void nkWinUi::ComboBox::exportIntrospection ( nkExport::Node rootNode)
overridevirtual

◆ importClassFromTree()

virtual void nkWinUi::ComboBox::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

The documentation for this class was generated from the following file: